home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr49 / 127_01.zip / -READ.ME < prev    next >
Text File  |  1993-06-17  |  5KB  |  135 lines
  1. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  2.  
  3. INSTRUCTIONS FOR COMPILING AND LINKING RAP -- August 1983
  4.  
  5. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  6.  
  7. Those wishing to use RAP should obtain a copy of the RAP Manual,
  8. a document of approximately 50 pages. Copies of the Manual may
  9. be obtained from Eric Martz, 48 Hunter's Hill Circle, Amherst MA
  10. 01002 for $10 postpaid within the USA, $20 overseas. Please
  11. prepay any such orders!
  12.  
  13. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  14.  
  15.  
  16. FILES:
  17.  
  18.      The RAP source code consists of the following modules:
  19.  
  20.           RAP.H (#included in all RAP*.C sources)
  21.           RAP.C
  22.           RAP1.C
  23.           RAP2.C
  24.           RAP3.C
  25.           RAP4.C
  26.           RAPIO.C
  27.  
  28.      The arrangement of functions in these modules is largely
  29. arbitrary so a catalog of the functions is in RAP.H.
  30. Unfortunately, the catalog is obsolete (needs revising). (Does
  31. anyone know of a program which will list the functions in a
  32. source code file and also all the functions called by each?)
  33.  
  34.      In addition to the RAP source files, the following general
  35. purpose files are included:
  36.  
  37.           BDSCIO+.H: Additons to standard BDSCIO.H
  38.           DEFF.CRL: Renamed compilation of MARTZLIB.C
  39.           DEFF2.CRL, DEFF3.CRL: Renamed DEFF.CRL, DEFF2.CRL from BDS
  40.           FIO1.H, FIO2.H, FIO3.H: K&R standard fopen, fclose for BDS
  41.           L2.COM: Mark of the Unicorn BDSC linker
  42.           LINK.SUB: Submit file to link RAP
  43.           MARTZLIB.C: General purpose function library (source on
  44.             another disk, CRL provided as DEFF.CRL, see below)
  45.  
  46.  
  47. COMPILATION:
  48.  
  49.      Compilation must be by the BDSC compiler. We are presently
  50. using version 1.5.
  51.  
  52.      RAP is too big. (A needed next step is to implement
  53. overlaying so there is more room for growth.)
  54.  
  55.      You will find that there is a lot of debugging source code, the
  56. compilation of which is made conditional upon having #defined DEBUG.
  57. You will find that #define DEBUG is commented out in RAP.H. If
  58. you #define DEBUG, RAP may not have enough stack space left in
  59. memory to operate in your system.
  60.  
  61.      In order to make RAP.COM fit into memory, it is necessary to
  62. use the -e option to fix the origin of external variables. Thus,
  63. to compile RAP.C, for example, use the command:
  64.  
  65.           cc1 rap -e 9800
  66.  
  67. The "-e 9800" must be used for compilation of all source files
  68. RAP*.C, but is not needed for MARTZLIB.C. The program text code
  69. presently ends around hex 93EE. Hence, setting the externals at
  70. hex 9800 leaves some room to grow. My system has 64K of memory.
  71. CP/M and MicroShell (which I HIGHLY recommend, available from New
  72. Generation Systems, 2153 Golf Course Dr, Reston VA 22091) each
  73. need about 8K, so my TPA ends at C006 (49157 decimal). This
  74. leaves me 7F8  (~2000 decimal) bytes of stack space, which seems
  75. to be enough.
  76.  
  77.  
  78. LINKING:
  79.  
  80.      Also in order to conserve space, it is necessary to use the
  81. Mark of the Unicorn L2 linker for BDSC, which produces a smaller
  82. .COM file than does CLINK. Since this is available from the BDSC
  83. User's Group, I have included L2.COM. The L2.COM included has two
  84. modifications. First, it automatically scans three default
  85. libraries (DEFF.CRL, DEFF2.CRL, and DEFF3.CRL). Second, the
  86. statistics summary is augmented. (Source code and documentation
  87. for L2 may be obtained from the BDSC User's Group, POB 287, Yates
  88. Center, KS 66783.) L2 saves 1344 bytes of jump tables! (RAP
  89. includes 133 functions.)
  90.  
  91.      In addition to the RAP source modules listed above, RAP
  92. requires some library functions in my personal library. The
  93. entire library has been made available as MARTZLIB.C. Although
  94. only a few of the functions in MARTZLIB are used by RAP, I hope
  95. you may find some others to be useful in your own programs. The
  96. source code for MARTZLIB is on another disk, but the CRL form is
  97. provided as DEFF.CRL as explained next.
  98.  
  99.      In order to link RAP, I rename the libraries as follows:
  100.  
  101.           Old Name       New Name
  102.           -----------------------
  103.           MARTZLIB.CRL   DEFF.CRL
  104.           DEFF.CRL       DEFF2.CRL
  105.           DEFF2.CRL      DEFF3.CRL
  106.  
  107. It is then possible to link RAP with this command (also provided as
  108. RAPLINK.SUB):
  109.  
  110.           l2 rap rap1 rap2 -l rap3 rap4 rapread rapio
  111.  
  112. For reasons detailed in FIO3.H, I have renamed some of the file
  113. opening and closing functions provided with BDSC. For this
  114. reason, as well as the possibility that I've forgotten some other
  115. non-standard-ism, I have included DEFF2.CRL and DEFF3.CRL, as
  116. well as DEFF.CRL in the forms which I know to work with RAP.
  117. DEFF2.CRL and DEFF3.CRL, of course, were written by Leor Zolman
  118. of BD Software.
  119.  
  120.  
  121. MANUAL:
  122.  
  123.      The files for the RAP manual are not included. It was felt
  124. that most users would much rather have a xerox of the manual
  125. itself, since the files are set up for printing on an obscure
  126. multi-font dot matrix printer (the Sanders 12/7). Also, printing
  127. RAP commands with RAP sometimes gets extraordinarily complicated.
  128.  
  129. FEEDBACK:
  130.  
  131.      I hope that some recipients of RAP will make significant
  132. enhancements and that they will be kind enough to send them to
  133. me, Eric Martz, Department of Microbiology, University of
  134. Massachusetts, Amherst MA 01003 USA.
  135. l2 rap rap1 rap2 -l rap3 rap4 rapread rapio